docs(building-plugins): document npm plugin sources#1227
Merged
Conversation
Contributor
|
Droid finished @factory-davidgu's task —— View job Review summarySolid, detailed docs for the new npm plugin source. A couple small clarifications around pinning/versioning semantics across source types will prevent readers from applying the marketplace (git commit hash) guidance to npm-based installs. |
Document the npm plugin source for marketplace manifests, including required/optional fields, the published package layout (Droid and Claude Code formats), install-time hardening defaults, and the wrapper-marketplace pattern for shipping a single npm-published plugin. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
factory-davidgu
force-pushed
the
dgu/docs-npm-plugin-source
branch
from
c9bd8b9 to
29b2748
Compare
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![factory-droid[bot]](https://avatars.githubusercontent.com/in/358017?s=60&v=4){kind=small}
factory-ain3sh
previously approved these changes
Jun 13, 2026
factory-ain3sh
left a comment
factory-ain3sh
left a comment
Contributor
There was a problem hiding this comment.
pls address review droid feedback before merging
…pm install constraints Addresses PR #1227 review feedback by disambiguating per-source pinning behavior (git ref/sha vs marketplace ref vs npm version) and scoping the existing git-commit-hash note to git-based sources. Also documents the runtime-enforced constraints from factory-mono#14467: registry URLs must be https with no credentials/query/fragment, version specs cannot be file:/git+/url/path/npm: aliases, the npm CLI must be on PATH, and postinstall-built packages must publish prebuilt artifacts because --ignore-scripts skips lifecycle scripts. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new
npmplugin source type for marketplace manifests inguides/building/building-plugins.mdx.What changed
github,url,git-subdir,npm).package,version,registry)package.jsonfilesconfiguration--ignore-scripts, scratch-scoped.npmrc)npm:is not a valid marketplace source.Notes
@your-org/droid-pr-triage,your-org-plugins,https://npm.your-org.example). No real published packages are referenced.dgu/npm-marketplace.